<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Template Parameter Definition Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">TemplateParameterDefinition Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Represents a definition for a template element.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Template Parameter Definition</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>XML Element:</td>
<td><code>template-parameter-definition</code></td></tr>
<tr><td>Extends:</td>
<td>None</td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>None</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>No</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-allowedType">allowedType</a></dt>
<dd>Name of the element type that is allowed in the definition.</dd>
<dt><a href="#Property-description">description</a></dt>
<dd>Description for this template definition.</dd>
<dt><a href="#Property-descriptionID">descriptionID</a></dt>
<dd>Resource key for the description text.</dd>
<dt><a href="#Property-name">name</a></dt>
<dd>Unique name of the template definition.</dd>
</dl>

<h3>Slot Summary</h3>

<dl class="section-text">
<dt><a href="#Slot-default">default</a></dt>
<dd>Slot that holds the default element of the TemplateParameterDefinition.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>Represents a template parameter definition element. A template parameter
definition gives a definition of a template element. It can be referred by one
template report item or one template data set. The template parameter
definition has the following properties:
 
<ul>
  <li>A required and unique name for this template parameter definition.
  <li>A type for this template parameter definition. It is a the enumeration
  of Table,Grid, Label, Text, ExtendedItem or other kind of report items and
  Dataset.
  <li>A static description message that will be show to the client user.
</ul></div>
<h1>Property Detail</h1>

<h2><a name="Property-allowedType">allowedType Property</a></h2>

<p class="section-text">Name of the element type that is allowed in the definition.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (templateElementType)</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Allowed type</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>Table</td>
<td>Table</td>
<td>Table</td>
<td></td></tr>
<tr><td>FreeForm</td>
<td>FreeForm</td>
<td>FreeForm</td>
<td></td></tr>
<tr><td>Data</td>
<td>Data</td>
<td>Data</td>
<td></td></tr>
<tr><td>Grid</td>
<td>Grid</td>
<td>Grid</td>
<td></td></tr>
<tr><td>Image</td>
<td>Image</td>
<td>Image</td>
<td></td></tr>
<tr><td>Label</td>
<td>Label</td>
<td>Label</td>
<td></td></tr>
<tr><td>List</td>
<td>list</td>
<td>List</td>
<td></td></tr>
<tr><td>Text</td>
<td>Text</td>
<td>Text</td>
<td></td></tr>
<tr><td>ExtendedItem</td>
<td>ExtendedItem</td>
<td>ExtendedItem</td>
<td></td></tr>
<tr><td>TextData</td>
<td>TextData</td>
<td>TextData</td>
<td></td></tr>
<tr><td>DataSet</td>
<td>DataSet</td>
<td>DataSet</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>Name of the property that defines the allowed element type of this
TemplateParameterDefinition. It is enumeration of Table,Grid, Label,
Text, ExtendedItem, other kind of report items and Dataset.</p></div>

<hr>
<h2><a name="Property-description">description Property</a></h2>

<p class="section-text">Description for this template definition.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Description</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Externalizable text giving a description for this template definition</p></div>

<hr>
<h2><a name="Property-descriptionID">descriptionID Property</a></h2>

<p class="section-text">Resource key for the description text.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Description ID</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Resource key for the externalizable description text.</p></div>

<hr>
<h2><a name="Property-name">name Property</a></h2>

<p class="section-text">Unique name of the template definition.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#name">name</a></td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Required and unique name for the template definition.</p></div>
<h1>Slot Detail</h1>

<h2><a name="Slot-default">default Slot</a></h2>

<p class="section-text">Slot that holds the default element of the TemplateParameterDefinition.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Default</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>XML Element:</td>
<td><code>default</code></td></tr>
<tr><td>Contents:</td>
<td><a href="Data.html">Data</a>, <a href="DataSet.html">DataSet</a>, <a href="ExtendedItem.html">ExtendedItem</a>, <a href="FreeForm.html">FreeForm</a>, <a href="Grid.html">Grid</a>, <a href="Image.html">Image</a>, <a href="Label.html">Label</a>, <a href="Line.html">Line</a>, <a href="List.html">List</a>, <a href="Table.html">Table</a>, <a href="Text.html">Text</a>, <a href="TextData.html">TextData</a></td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The slot that holds the default element, the element will be used when a new element is 
created from the template.</p></div>
</body>
</html>
